Document localhost OpenAPI previews - #7156
Open
hamedrabah wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
Documents the existing local OpenAPI workflow:
Closes #617
Validation
Note
Low Risk
Documentation-only change with no runtime, auth, or data-handling impact.
Overview
Adds a Use a localhost specification section to the OpenAPI setup guide so developers can preview API docs against a spec served from their machine during local work.
The new content shows pointing
navigation.openapiat ahttp://localhost:…URL, runningmint dev --local-schemaso the CLI can fetch that spec over HTTP, and the same--local-schemaflag withmint validatewhen checking config without a dev server. It also states that production OpenAPI URLs must use HTTPS.Reviewed by Cursor Bugbot for commit d1bbaee. Bugbot is set up for automated code reviews on this repo. Configure here.